ocs: add multilingual README support for Simplified Chinese, Traditional Chinese, and Japanese#22
Conversation
0xbeekeeper
left a comment
0xbeekeeper
left a comment
There was a problem hiding this comment.
Thanks for the translations! Quality looks good overall. A few things to address before merging:
Must fix
-
PR title typo:
ocs:→docs:— please update the title. -
Verify doc links in translated files: The translated READMEs link to
../SECURITY-POLICY.md,../mcp-server.md,../sdk.md,../trust-cli.md,../goplus-api.md,../architecture.md(relative todocs/i18n/). Please confirm these files exist underdocs/— otherwise the links will 404.
Suggestions (nice-to-have)
-
Add a sync marker to each translated file header (e.g.
<!-- synced with README.md as of commit abc1234 -->). This makes it easy to tell when a translation falls behind the English source. -
docs/i18n/README.mdoverlaps withCONTRIBUTING.md— the translation naming convention and maintenance rules appear in both. Consider keeping it in one place to avoid drift.
Otherwise the translations are faithful, links between language versions are correct, and there's no security concern (pure docs, no code changes). Happy to approve once the title and links are verified. 👍
2 participants
Summary
This PR adds multilingual README support to make AgentGuard more
accessible to a broader developer audience.
Changes
docs/i18n/docs/i18n/README.zh-Hans.mddocs/i18n/README.zh-Hant.mddocs/i18n/README.ja.mdREADME.mdCONTRIBUTING.mdwith translation file naming andorganization guidelines
Why
This project was shared with me through a community meetup, and while the English README is readable, it still creates friction for non-native English users during installation and initial evaluation.
For security tools like AgentGuard, reducing that friction matters. A localized README helps users understand the project faster, install it more confidently, and evaluate its capabilities without relying on browser translation tools or external plugins.
This PR aims to improve accessibility for users who are more comfortable reading Simplified Chinese, Traditional Chinese, or Japanese, while keeping the English README as the canonical source.
Notes
README.mdremains the source of truthdocs/i18n/to keep therepository root clean